Listar Documentos

Este endpoint permite listar os documentos criados para assinatura eletrônica com a possibilidade de filtrar pelo businessId do documento e paginar os resultados.

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Requisição

GET https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents JWT scope: doc-signature/read:documents

Parâmetros

Nome	Tipo	Descrição
filter[businessId]	string	Opcional. Identificador do documento no sistema do parceiro.
page[number]	number	Opcional. Número da página a ser retornada. O padrão é 1.
page[size]	number	Opcional. Quantidade de registros por página. O padrão é 10.

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Accept	application/json

Respostas

Código	Descrição
200	Retorna a lista de documentos criados para assinatura eletrônica.
401	Não autorizado

Paginação

A paginação é feita através dos parâmetros page[number] e page[size]. O parâmetro page[number] indica o número da página a ser retornada, enquanto o parâmetro page[size] indica a quantidade de registros por página. Em cada resposta, a API retorna os links para a primeira (first), última (last), próxima (next) e anterior (prev).

Por padrão a API retorna os 10 primeiros documentos criados para assinatura eletrônica. Os registros são ordenados por data de criação, do mais antigo para o mais recente.

info

Caso não exista uma próxima página, o link next terá o valor null. Da mesma forma, caso não exista uma página anterior, o link prev terá o valor null.

Filtros

A API permite filtrar os documentos pelo businessId do documento. Para isso, basta informar o parâmetro filter[businessId] na requisição.

Exemplo de uso sem filtros ou paginação

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Accept", "application/json");

const requestOptions = {
  method: "GET",
  headers: headers,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request POST 'https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents' \
-H 'Authorization: Bearer <token>' \
-H 'Accept: application/json'

Resposta

{
  "data": [
    {
      "type": "documents",
      "id": "c58a0dc6-f862-40eb-92cd-20922d1d618a",
      "attributes": {
        "status": "pending",
        "businessId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
        "signers": [
          {
            "businessId": "XPTO-CLIENTE-12345-001",
            "name": "Fulano de Tal",
            "email": "fulano@example.com"
          }
        ]
      },
      "links": {
        "self": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents/c58a0dc6-f862-40eb-92cd-20922d1d618a"
      }
    }
  ],
  "links": {
    "self": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents",
    "first": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "last": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "prev": null,
    "next": null
  }
}

Exemplo de uso com filtro

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Accept", "application/json");

const requestOptions = {
  method: "GET",
  headers: headers,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?filter[businessId]=dca749e9-e60e-490e-936a-64fbc6eb67f9",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request POST 'https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?filter[businessId]=dca749e9-e60e-490e-936a-64fbc6eb67f9' \
-H 'Authorization: Bearer <token>' \
-H 'Accept: application/json'

Resposta

{
  "data": [
    {
      "type": "documents",
      "id": "c58a0dc6-f862-40eb-92cd-20922d1d618a",
      "attributes": {
        "status": "pending",
        "businessId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
        "signers": [
          {
            "businessId": "XPTO-CLIENTE-12345-001",
            "name": "Fulano de Tal",
            "email": "fulano@example.com"
          }
        ]
      },
      "links": {
        "self": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents/c58a0dc6-f862-40eb-92cd-20922d1d618a"
      }
    }
  ],
  "links": {
    "self": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents",
    "first": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "last": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "prev": null,
    "next": null
  }
}

Exemplo de uso com paginação

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Accept", "application/json");

const requestOptions = {
  method: "GET",
  headers: headers,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page[number]=1&page[size]=10",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request POST 'https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page[number]=1&page[size]=10' \
-H 'Authorization: Bearer <token>' \
-H 'Accept: application/json'

Resposta

{
  "data": [
    {
      "type": "documents",
      "id": "c58a0dc6-f862-40eb-92cd-20922d1d618a",
      "attributes": {
        "status": "pending",
        "businessId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
        "signers": [
          {
            "businessId": "XPTO-CLIENTE-12345-001",
            "name": "Fulano de Tal",
            "email": "fulano@example.com"
          }
        ]
      },
      "links": {
        "self": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents/c58a0dc6-f862-40eb-92cd-20922d1d618a"
      }
    }
  ],
  "links": {
    "self": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "first": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "last": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page%5Bnumber%5D=3&page%5Bsize%5D=10",
    "prev": null,
    "next": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents?page%5Bnumber%5D=2&page%5Bsize%5D=10"
  }
}